GobiVoiceMgmtAPI.h

/*===========================================================================
FILE: 
   GobiVoiceMgmtAPI.h

DESCRIPTION:
   
==========================================================================*/

#ifndef GobiVoiceMgmtAPI_H
#define GobiVoiceMgmtAPI_H
/*=========================================================================*/
// Definitions
/*=========================================================================*/
#ifdef GOBIAPI_EXPORTS
        #define IMPORTGOBI extern "C" __declspec( dllexport )   
#else  //GOBIAPI_EXPORTS
        #ifdef __cplusplus
                /* C++ callable DLL */
                #define IMPORTGOBI extern "C" __declspec( dllimport )   
        #else
                /* C callable DLL */
                #define IMPORTGOBI __declspec( dllimport )
        #endif
#endif //GOBIAPI_EXPORTS

// Calling convention for API
#define GOBICALLBACK __stdcall
#define GOBICMAPI __stdcall

#ifdef GOBIAPI_EXPORTS
       #define SWIIMPORT extern "C" __declspec( dllexport )   
#else  //GOBIAPI_EXPORTS
    #ifdef __cplusplus
       /* C++ callable DLL */
       #define SWIIMPORT extern "C" __declspec( dllimport )   
    #else
       /* C callable DLL */
       #define SWIIMPORT __declspec( dllimport )
    #endif
#endif //GOBIAPI_EXPORTS
// Calling convention for API
#define SWICALLBACK __stdcall
#define SWICMAPI __stdcall

#ifdef __cplusplus
   extern "C" {
#endif


#define MAXUSSDLENGTH          256//182
#define MAX_CALL_NO_LEN        81
#define MAX_DESCRIPTION_LENGTH 255
#define PASSWORD_LENGTH        5
#define PASSWORD_STRLEN            4
#define MAX_NO_OF_CALLS        8
#define MAX_WATITINGMSG                 5
#define MAX_CELLINFO_PLMN               3
#define MAX_SESSIONINFO                 512
#define MAX_PKG_DESCRIPTION             1528

typedef struct
{
    BYTE                OMAInitState;
    BYTE                sessionState;
        BYTE            HFAState;
        WORD            HFARetryTimes;
        WORD            HFARetryInterval;
        WORD            HFARetryCount;
        BYTE            FUMOState;
        LONG            FUMOResult;
        WORD            vendorNameLen;
        TCHAR           vendorName[MAX_SESSIONINFO];
        LONG            imageSize;
        WORD            pkgVerStrLen;
        TCHAR           pkgVerStr[MAX_SESSIONINFO];
        WORD            pkgNameLen;
        TCHAR           pkgName[MAX_SESSIONINFO];
        WORD            pkgDesLen;
        TCHAR           pkgDescription[MAX_PKG_DESCRIPTION];
        WORD            pkgDateLen;
        TCHAR           pkgDate[MAX_SESSIONINFO];
        WORD            pkgTimeLen;
        TCHAR           pkgTime[MAX_SESSIONINFO];
} omaSessionInfo;

typedef struct
{
    BYTE                FUMOState;
        BYTE            dummy;
        WORD            UITimeOut;
        LONG            pkgSize;
        LONG            pkgReceivedByte;
        WORD            FUMOResult;
        WORD            pkgVerStrLen;
        TCHAR           pkgVerStr[MAX_SESSIONINFO];
        WORD            pkgNameLen;
        TCHAR           pkgName[MAX_SESSIONINFO];
        WORD            pkgDesLen;
        TCHAR           pkgDescription[MAX_PKG_DESCRIPTION];
} FUMOInfo;

typedef struct
{
    BYTE                DMState;
        BYTE            UIOption;
        WORD            UITimeOut;
        WORD            alertStrLen;
        TCHAR           alertStr[MAX_SESSIONINFO];
} OMAInfo;

typedef struct
{
        ULONG           cellid; 
        CHAR            plmn[MAX_CELLINFO_PLMN];
        WORD            lac;
        WORD            arfcn;
        BYTE            bsic;
        ULONG           timing;
        WORD            rxLv;
} geranCellInfo;

typedef struct
{
        WORD            cellid;
        CHAR            plmn[MAX_CELLINFO_PLMN];
        WORD            lac;
        WORD            uarfcn;
        WORD            psc;
        WORD            rscp;
        WORD            ecio;
} umtsCellInfo;

typedef struct
{
        WORD            sid;
        WORD            nid;
        WORD            baseid;
        WORD            refpn;
        ULONG           base_lat;
        ULONG           base_long;
} cdmaCellInfo;

typedef struct 
{
    BYTE ussDCS;
    BYTE ussLen;
    CHAR ussData[MAXUSSDLENGTH+1];
} USSInfo;

typedef struct
{
    BYTE UUSType;
    BYTE UUSDcs;
    BYTE UUSDatalen;
    CHAR UUSData[MAX_DESCRIPTION_LENGTH];
} UUSInfo;

typedef struct
{
    WORD CUGIndex;
    BYTE SuppPrefCUG;
    BYTE SuppOA;
} CUGInfo;

typedef struct
{
    BYTE extBit;
    BYTE subAddrType;
    BYTE oddEvenInd;
    BYTE subAddrLen;
    CHAR subAddr[MAX_DESCRIPTION_LENGTH];
} calledPartySubAdd;

typedef struct
{
    CHAR              callNumber[MAX_CALL_NO_LEN];
    BYTE              *pCallType;
    BYTE              *pCLIRType;
    UUSInfo           *pUUSInfo;
    CUGInfo           *pCUGInfo;
    BYTE              *pEmergencyCategory;
    calledPartySubAdd *pCallPartySubAdd;
    ULONG             *pSvcType;
} tDialReqParam;

typedef struct
{
   BYTE alphaDcs;
   BYTE alphaLen;
   CHAR alphaText[MAX_DESCRIPTION_LENGTH];
} alphaIDInfo;

typedef struct
{
   BYTE svcType;
   BYTE reason;
} ccSUPSType;

typedef struct
{
    BYTE callID;
    BYTE callState;
    BYTE callType;
    BYTE direction;
    BYTE mode;
        BYTE isMpty;
        BYTE als;
} allcallInfo;

typedef struct
{
    BYTE callID;
    BYTE callState;
    BYTE callType;
    BYTE direction;
    BYTE mode;
} callInfo;


typedef struct
{
    BYTE                numInstances;
    allcallInfo         callInfo[MAX_NO_OF_CALLS];
} arrCallInfo;

typedef struct
{
    BYTE numPI;
    BYTE numSI;
    BYTE numType;
    BYTE numPlan;
    BYTE numLen;
    CHAR number[MAX_CALL_NO_LEN];
} peerNumInfo;

typedef struct
{
    BYTE callID;
    BYTE numPI;
    BYTE numSI;
    BYTE numType;
    BYTE numPlan;
    BYTE numLen;
    CHAR number[MAX_CALL_NO_LEN];
} allpeerNumInfo;

typedef struct
{
    BYTE                numInstances;
    allpeerNumInfo      info[MAX_NO_OF_CALLS];
} arrPeerNumInfo;

typedef struct
{
        BYTE PI;
    BYTE numLen;
    CHAR number[MAX_CALL_NO_LEN];
} remotePartyNum;


typedef struct
{
    BYTE callID;
        BYTE PI;
    BYTE numLen;
    CHAR number[MAX_CALL_NO_LEN];
} allremotePartyNum;

typedef struct
{
    BYTE                        numInstances;
    allremotePartyNum           rmtPtyNum[MAX_NO_OF_CALLS];
} arrRemotePartyNum;

typedef struct
{
   BYTE diagInfoLen;
   CHAR diagnostic[MAX_DESCRIPTION_LENGTH];
} diagInfo;

typedef struct
{
   BYTE callID;
   BYTE diagInfoLen;
   CHAR diagnostic[MAX_DESCRIPTION_LENGTH];
} alldiagInfo;

typedef struct
{
    BYTE             numInstances;
    alldiagInfo  diag[MAX_NO_OF_CALLS];
} arrDiagInfo;

typedef struct
{
        BYTE            numInstances;
    BYTE        callID[MAX_NO_OF_CALLS];
    alphaIDInfo info[MAX_NO_OF_CALLS];
} arrAlphaIDInfo;

typedef struct
{
    BYTE namePI;
    BYTE codingScheme;
    BYTE nameLen;
    CHAR name[MAX_DESCRIPTION_LENGTH];
} remotePartyName;

typedef struct
{
    BYTE callID;
    BYTE namePI;
    BYTE codingScheme;
    BYTE nameLen;
    CHAR name[MAX_DESCRIPTION_LENGTH];
} allremotePartyName;

typedef struct
{
    BYTE                numInstances;
    allremotePartyName  RmtPtyName[MAX_NO_OF_CALLS];
} arrRemotePartyName;


typedef struct
{
   BYTE numInstances;
   BYTE callID[MAX_NO_OF_CALLS];
   WORD callEndReason[MAX_NO_OF_CALLS];
} arrCallEndReason;

typedef struct
{
  BYTE numInstances;
  BYTE callID[MAX_NO_OF_CALLS];
  WORD srvOption[MAX_NO_OF_CALLS];
} arrSvcOption;


typedef struct
{
    BYTE            numInstances;
        BYTE                    callID[MAX_NO_OF_CALLS];        
    UUSInfo             UUSInfo[MAX_NO_OF_CALLS];
} arrUUSInfo;


typedef struct
{
    BYTE numInstances;
    BYTE callID[MAX_NO_OF_CALLS];
    BYTE alertingType[MAX_NO_OF_CALLS];
} arrAlertingType;


typedef struct
{
     BYTE  numInstances;
     BYTE  callID[MAX_NO_OF_CALLS];
     ULONG alertingPattern[MAX_NO_OF_CALLS];
} arrAlertingPattern;

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} CLIRResp;

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} statusResp;

typedef struct
{
     BYTE  ectCallState;
     BYTE  pi;
         BYTE  numLen;
     CHAR number[MAX_DESCRIPTION_LENGTH];
} ectInfo;

typedef struct
{
    BYTE numberType;
    BYTE numberPlan;
} callFwdTypeAndPlan;

typedef struct
{
    BYTE voiceSvc;
    BYTE reason;
    BYTE *pServiceClass;
    BYTE *pCallBarringPasswd;
    BYTE *pCallForwardingNumber;
    BYTE *pTimerVal;
    callFwdTypeAndPlan *pCallFwdTypeAndPlan;
} voiceSetSUPSServiceReq;

typedef struct
{
    BYTE SvcStatus;
    BYTE SvcClass;
    BYTE numLen;
    CHAR number[MAX_DESCRIPTION_LENGTH];
    BYTE noReplyTimer;
} callFWInfo;

typedef struct
{
    BYTE       numInstances;
    callFWInfo CallFWInfo[MAX_NO_OF_CALLS];
} getCallFWInfo;


typedef struct
{
    BYTE SvcStatus;
    BYTE SvcClass;
        BYTE noReplyTimer;
        BYTE pi;
        BYTE si;
        BYTE numType;
    BYTE numLen;
    CHAR number[MAX_DESCRIPTION_LENGTH];
} extCallFWInfo;

typedef struct
{
    BYTE                numInstances;
    extCallFWInfo       extFWInfo[MAX_NO_OF_CALLS];
} getExtCallFWInfo;


typedef struct
{
    BYTE reason;
    CHAR oldPwd[PASSWORD_LENGTH];
    CHAR newPwd[PASSWORD_LENGTH];
    CHAR newPwdAgain[PASSWORD_LENGTH];
} callBarringPwd;

typedef struct
{
    BYTE  namID;
    ULONG airTimerValue;
} airTimer;

typedef struct
{
    BYTE  namID;
    ULONG roamTimerValue;
} roamTimer;

typedef struct
{
    BYTE namID;
    BYTE evrcCapability;
    WORD homePageVoiceSO;
    WORD homeOrigVoiceSO;
    WORD roamOrigVoiceSO;
} prefVoiceSO;

typedef struct
{
    BYTE gsmAmrStat;
    BYTE wcdmaAmrStat;
} curAMRConfig;

typedef struct
{
    BYTE callID;
    BYTE DTMFEvent;
    BYTE digitCnt;
    BYTE digitBuff[MAX_DESCRIPTION_LENGTH];
} DTMFInfo;


typedef struct
{
    BYTE sigType;
    BYTE alertPitch;
    BYTE signal;
} signalInfo;

typedef struct
{
        BYTE PI;
    BYTE callerIDLen;
    CHAR callerID[MAX_CALL_NO_LEN];
} callerIDInfo;

typedef struct
{
    BYTE numPI;
    BYTE numSI;
    BYTE numType;
    BYTE numPlan;
        BYTE reason;
    BYTE numLen;
    CHAR number[MAX_CALL_NO_LEN];
} redirectNumInfo;

typedef struct
{
        BYTE polarity;
    BYTE toggle;
    BYTE reversePolarity;
    BYTE time;
} lineCtlInfo;

typedef struct
{
        BYTE type;
    BYTE extDisplayLen;
    CHAR extDisplay[MAX_DESCRIPTION_LENGTH];
} extDisplayInfo;




typedef struct
{
    BYTE    numInstances;
    BYTE        msgType[MAX_WATITINGMSG];
    BYTE        indStatus[MAX_WATITINGMSG];
    BYTE        msgCount[MAX_WATITINGMSG];
} waitingMsgInfo;

// Voice Call Status callback function
typedef void (GOBICALLBACK * tFNCallInfo)(
        arrCallInfo*            allCallInfo,
        arrRemotePartyNum*      remoteNumInfo,
        arrRemotePartyName* remoteName,
        arrAlertingType*        alertType,
        arrSvcOption*           servieOpt,
        arrCallEndReason*   callEnd,
        arrAlphaIDInfo* alphaIDInfo,
        arrPeerNumInfo*  connectedPartyInfo,
        arrDiagInfo* diagInfo,
        arrPeerNumInfo* calledPartyInfo,
        arrPeerNumInfo* redirectInfo,
        arrAlertingPattern* alertPattern);

// Voice Privacy callback function
typedef void (GOBICALLBACK * tFNPrivacyInfo)(
        BYTE* pCallID,
        BYTE* pVoicePrivacy);
        
// Voice OTASP Status callback function
typedef void (GOBICALLBACK * tFNOTASPStatus)(
        BYTE* pCallID,
        BYTE* pOtaspStatus);

typedef void (GOBICALLBACK * tFNSupsInfo)(
        BYTE* pCallID,
        BYTE* pType,
        WORD* pIndex,
        ectInfo* pECT);

typedef void (GOBICALLBACK * tFNUSSDNoWait)(
        WORD* pError,
        WORD* pFailure,
        USSInfo* pUSSD,
        alphaIDInfo* pAlpha);
        
typedef void (GOBICALLBACK * tFNAOCLowFunds)();
        
typedef void (GOBICALLBACK * tFNUSSDRelease)(); 

typedef void (GOBICALLBACK * tFNUSSD)(
        BYTE*    pType,
        USSInfo* pUSSD);

typedef void (GOBICALLBACK * tFNUUS)(
        BYTE*    pCallID,
        UUSInfo* pUUS); 

typedef void (GOBICALLBACK * tFNDTMF)(
        DTMFInfo* pDTMFInfo,
        BYTE*     pOnLength,
        BYTE*     pOffLength);  
        
typedef void (GOBICALLBACK * tFNSUPS)(
        BYTE*     pType,
        BYTE*     pCCModified,
        BYTE*     pClass,
        BYTE*     pReason,
        CHAR*     pNumber,
        BYTE*     pTimer,
        USSInfo*  pUSS,
        BYTE*     pCallID,
        BYTE*     pAlpha,
        CHAR*     pPwd,
        CHAR*     pNewPwd,
        CHAR*     pNewPwdAgain,
        BYTE*     pDataSource,
        LONG*     pCause,
        getCallFWInfo*    pCallFwdData,
        CLIRResp*                 pCLIR,
        statusResp*       pCLIP,
        statusResp*       pCOLP,
        statusResp*       pCOLR,
        statusResp*       pCNAP);       
        
typedef void (GOBICALLBACK * tFNInfoRec)(
        BYTE*                           pCallID,
        signalInfo*                     pSignal,
        callerIDInfo*           pCallIDInfo,
        CHAR*                           pDisplay,
        CHAR*                           plvDisplayExt,
        CHAR*                           pCallerName,
        BYTE*                           pCallWaiting,
        peerNumInfo*            pConnectedInfo,
        peerNumInfo*            pCallingPartyInfo,
        peerNumInfo*            pCalledPartyInfo,
        redirectNumInfo*        pRedirectInfo,
        BYTE*                           pCLIRCause,
        BYTE*                           pUplink,
        BYTE*                           pDownlink,
        BYTE*                           pNSS,
        lineCtlInfo*            pLineCtlInfo,
        extDisplayInfo*         pDisplayExtInfo);       

        
// SwiOMAEx callback function   
typedef void (GOBICALLBACK * tFNSwiOmaExEvent)(
        FUMOInfo*                       pFUMOInfo,
        OMAInfo*                        pOMAInfo);      
        
// USSD origination callback function
typedef void (GOBICALLBACK * tFNUSSDOrigination)( 
   ULONG                      errorCode,
   ULONG                      failureCause,
   BYTE *                     pNetworkInfo,
   BYTE *                     pAlpha );
        
// USSD notification callback function
typedef void (GOBICALLBACK * tFNUSSDNotification)( 
   ULONG                      type,
   BYTE *                     pNetworkInfo );
        
// USSD release callback function
typedef void (GOBICALLBACK * tFNUSSDRelease)();
        
#ifdef __cplusplus
   };
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/
IMPORTGOBI ULONG GOBICMAPI      AnswerCall(
    // req params
        BYTE*           pInCallID,
        // resp params
        BYTE*           pOutCallID);

IMPORTGOBI ULONG GOBICMAPI      EndCall( 
        // req params
        BYTE*           pInCallID,
        // resp params
        BYTE*           pOutCallID
        );
IMPORTGOBI ULONG GOBICMAPI      DialCall( 
        // req params
        tDialReqParam* pDialReq,
        // resp params
        BYTE*                   pCallID,
        alphaIDInfo*    pAlpha,
        BYTE*                   pCCResult,
        ccSUPSType*             pServiceType
        );

IMPORTGOBI ULONG GOBICMAPI      GetConfig( 
        // req params
        BYTE*           pAutoAns,
        BYTE*           pAirTimer,
        BYTE*           pRoamTimer,
        BYTE*           pTTYMode,
        BYTE*           pPerfVoiceSO,
        BYTE*           pAMRstatus,
        BYTE*           pVoicePrivacy,
        BYTE*           pNamID,
        BYTE*           pVoiceDomainPref,
        // resp params
        BYTE*                   pAutoAnsStatus,
        airTimer*               pAirTimerCount,
        roamTimer*              pRoamTimerCount,
        BYTE*                   pCurTTYMode,
        prefVoiceSO*    pCurPrefVoiceSO,
        curAMRConfig*   pCurAMRConfig,
        BYTE*                   pCurPrivacyPref,
        BYTE*                   pCurDomain
        );

IMPORTGOBI ULONG GOBICMAPI      SetConfig( 
        // req params
        BYTE*                   pAutoAnswer,
        airTimer*               pAirTimer,
        roamTimer*              pRoamTimer,
        BYTE*                   pTTYMode,
        prefVoiceSO*    pPrefVoiceSO,
        BYTE*                   pPrefVoiceDomain,
        // resp params
        BYTE*           pAutoAnsStatus,
        BYTE*           pAirTimerStatus,
        BYTE*           pRoamTimerStatus,
        BYTE*           pTTYConfigStatus,
    BYTE*               pPrefVoiceSOStatus,
    BYTE*               pVoiceDomainStatus
        );
        
/*===========================================================================
METHOD:
   SetUSSDOriginationCallback

DESCRIPTION:
   Enable/disable USSD origination callback function
  
PARAMETERS:
   pCallback   [ I ] - Callback function

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI SetUSSDOriginationCallback( 
   tFNUSSDOrigination         pCallback );


  /*===========================================================================
METHOD:
   SetUSSDNotificationCallback

DESCRIPTION:
   Enable/disable USSD notification callback function
  
PARAMETERS:
   pCallback   [ I ] - Callback function

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
SWIIMPORT ULONG SWICMAPI SetUSSDNotificationCallback( tFNUSSD pCallback );

/*===========================================================================
METHOD:
   SetUSSDReleaseCallback

DESCRIPTION:
   Enable/disable USSD release callback function
  
PARAMETERS:
   pCallback   [ I ] - Callback function

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
IMPORTGOBI ULONG GOBICMAPI SetUSSDReleaseCallback( 
   tFNUSSDRelease             pCallback );

   
/*===========================================================================
METHOD:
   SetCallInfoCallback

DESCRIPTION:
   Setup handler for QMI indication 
   QMI_VOICE_ALL_CALL_STATUS_IND_MSG 0x002E
  
PARAMETERS:
   pCallback   [ I ] - Callback function

RETURN VALUE:
   ULONG - Return code
===========================================================================*/
SWIIMPORT ULONG SWICMAPI SetCallInfoCallback( tFNCallInfo pCallback );   
   
#endif //GobiVoiceMgmtAPI_H